@interopio/browser API Reference

Access via:io.appManager.myApplication

Object describing an app.

Properties (19)

Property Type Default Required Description
allowMultiple⚓︎ boolean true

If true, the app can have multiple instances.
autoStart⚓︎ boolean x

If true, the app is auto started with the framework.
available⚓︎ boolean x

If true, the app is available and can be started.
caption⚓︎ string x x

Application caption.
container⚓︎ string x

Container identifier.
hidden⚓︎ boolean false

If true, the app will be hidden in the io.Connect Launcher.
icon⚓︎ string x x

Application icon.
iconURL⚓︎ string x

URL of the app icon.
instances⚓︎ Instance[] x

Instances of that app.
isShell⚓︎ boolean false

If true, the app is a shell app.
keywords⚓︎ string[] x x

An array of keywords for discovering the app more easily.
mode⚓︎ WindowMode | "unknown" x

Mode of the app window. Possible values are "flat", "tab", "html" or "frameless". If the mode can't be determined (e.g., for external apps), the value is "unknown".
name⚓︎ string x

Application name.
sortOrder⚓︎ number x

Sort indicator used when ordering apps in a list.
title⚓︎ string x x

Application title.
type⚓︎ string x

Type of the app.
userProperties⚓︎ PropertiesObject x

Generic object for passing properties, settings, etc., in the for of key/value pairs.
version⚓︎ string x x

Application version.
windowSettings⚓︎ WindowSettings x

Describes the settings for the app window.

8 Methods

getConfiguration()⚓︎

() => Promise<Definition>

Retrieves the definition of the current app.

io.Connect Browser 4.3

onAvailable()⚓︎

(callback: (app: Application) => any) => UnsubscribeFunction

Notifies when the app becomes available.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onChanged()⚓︎

(callback: (app: Application) => any) => void

Notifies when the app configuration is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onInstanceStarted()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Subscribes for the event which fires when an application instance is started. Note: unlike the API's onInstanceStarted() the Application's onInstanceStarted() method doesn't replay the already started instances.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function to handle the newly started instance.

Returns

Unsubscribe function.

onInstanceStopped()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Subscribes for the event which fires when an application instance is stopped.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function to handle the newly started instance.

Returns

Unsubscribe function.

onRemoved()⚓︎

(callback: (app: Application) => any) => void

Notifies when the app is removed.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onUnavailable()⚓︎

(callback: (app: Application) => any) => UnsubscribeFunction

Notifies when the app becomes unavailable.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

start()⚓︎

(context?: object, options?: ApplicationStartOptions) => Promise<Instance>

Returns the newly started application instance.

Parameters (2)

Name Type Required Description
context⚓︎ object x

The initial context of the application.
options⚓︎ ApplicationStartOptions x

Options object in which you can specify window setting (that will override the default configuration settings), as well as other additional options.

Returns

Promise that resolves with the newly started application instance.